feat(repo): apply GC OSS Repo Template#55
Conversation
wg102
left a comment
There was a problem hiding this comment.
Is it normal the System overview section in the readme is eng only?
|
@bryanpaget I noticed this pr changes the distribution license of the project to MIT, I believe the current license in your project is a GNU GPL (https://github.com/StatCan/namespace-cleaner/blob/main/LICENSE.txt), are you changing it? |
There was a problem hiding this comment.
Pull Request Overview
This PR applies the GC OSS repository template by adding standard governance files and enhancing documentation with bilingual support.
- Add
SECURITY.mdwith vulnerability reporting guidelines in English and French. - Expand
README.mdto include detailed project overview, key features, CI/CD integration, configuration, and monitoring – all presented bilingually. - Introduce
CONTRIBUTING.mdandCODE_OF_CONDUCT.mdfollowing the GC template, both with English and French sections.
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| SECURITY.md | Add security reporting instructions in English and French. |
| README.md | Update project README with bilingual sections and template layout. |
| CONTRIBUTING.md | Add contribution guidelines in English and French. |
| CODE_OF_CONDUCT.md | Add code of conduct in English and French. |
Comments suppressed due to low confidence (2)
README.md:93
- [nitpick] To keep the README fully bilingual, add a French equivalent heading (e.g., ‘## Vue d’ensemble du système’) before or after this line.
## System Overview
README.md:209
- [nitpick] Consider adding a French translation for this section heading and inline comments to match the bilingual style used elsewhere.
## Configuration
|
|
||
| ## Sécurité | ||
|
|
||
| **Ne publiez aucun problème de sécurité sur le dépôt publique!** Les vulnérabilités de sécurité doivent être signalées par courriel à `statcan.cybersecurity-cybersecurite.statcan@statcan.gc.ca` |
There was a problem hiding this comment.
In French, ‘dépôt’ is masculine, so the adjective should be ‘public’ rather than ‘publique’.
| **Ne publiez aucun problème de sécurité sur le dépôt publique!** Les vulnérabilités de sécurité doivent être signalées par courriel à `statcan.cybersecurity-cybersecurite.statcan@statcan.gc.ca` | |
| **Ne publiez aucun problème de sécurité sur le dépôt public!** Les vulnérabilités de sécurité doivent être signalées par courriel à `statcan.cybersecurity-cybersecurite.statcan@statcan.gc.ca` |
|
|
||
| ### Sécurité | ||
|
|
||
| **Ne publiez aucun problème de sécurité sur le dépôt publique!** Voir [SECURITY.md](SECURITY.md) No newline at end of file |
There was a problem hiding this comment.
Apply the same correction here: use ‘dépôt public’ instead of ‘dépôt publique’.
| **Ne publiez aucun problème de sécurité sur le dépôt publique!** Voir [SECURITY.md](SECURITY.md) | |
| **Ne publiez aucun problème de sécurité sur le dépôt public!** Voir [SECURITY.md](SECURITY.md) |
|
|
||
| #### License | ||
|
|
||
| Unless otherwise noted, the source code of this project is covered under Crown Copyright, Government of Canada, and is distributed under the [GNU Affero General Public License](LICENSE). |
There was a problem hiding this comment.
I like this, no suggestion, just a happy comment :)
| ## Key Features | ||
|
|
||
| * ✅ **Automated Lifecycle Management** – Label-based namespace retention system | ||
| * 🔒 **Security First** – Azure Entra ID user verification with domain allowlist | ||
| * 🧪 **Testing Friendly** – Mock and dry-run support | ||
| * ☁️ **Safe Operations** – Prevent accidental deletion through preview-only mode |
There was a problem hiding this comment.
Shouldn't this section be above with the rest of the english section? Sorry for all the comments lol
| ## CI/CD Integration / Intégration CI/CD | ||
|
|
||
| Our GitHub Actions pipeline includes: | ||
| Notre pipeline GitHub Actions comprend : | ||
|
|
||
| * ✅ Unit testing and dry-run validation | ||
| ✅ Tests unitaires et validation en mode simulation | ||
| * 🔒 Trivy-based container image vulnerability scanning | ||
| 🔒 Analyse de vulnérabilités des images avec Trivy | ||
| * 📦 Docker builds on push | ||
| 📦 Construction des images Docker lors des *push* | ||
| * 📈 Live test coverage badge generation | ||
| 📈 Génération d'un badge de couverture de test en temps réel |
There was a problem hiding this comment.
Shouldn't the english and french be separated?
Context:
Todo:
Expected Outcome: